Encode contributing.md style guide to .editorconfig
#9515
Conversation
| ij_java_block_comment_add_space = false | ||
| ij_java_block_comment_at_first_column = false | ||
| ij_java_line_comment_add_space = true | ||
| ij_java_line_comment_add_space_on_reformat = false | ||
| ij_java_line_comment_at_first_column = false |
There was a problem hiding this comment.
note: Personal take on this, I think comments should be indented by default to the correct context, instead of being at the beginning of the line.
E.g. this
@TaskAction
instrument() {
workQueue().submit(InstrumentAction.class, parameters -> {
-// parameters.buildStartedTime.set(this.invocationDetails.buildStartedTime)
-// parameters.pluginClassPath.from(this.pluginClassPath)
-// parameters.plugins.set(this.plugins)
+ // parameters.buildStartedTime.set(this.invocationDetails.buildStartedTime)
+ // parameters.pluginClassPath.from(this.pluginClassPath)
+ // parameters.plugins.set(this.plugins)
parameters.instrumentingClassPath.setFrom(this.instrumentingClassPath)
parameters.sourceDirectory.set(this.sourceDirectory.asFile)
parameters.targetDirectory.set(this.targetDirectory.asFile)
})
}
There was a problem hiding this comment.
❔ question: spotless enforces us to move the // near to the code while the editor puts it at the start of line by default.
Will the editor put it in the right place with this config?
There was a problem hiding this comment.
📝 notes: My preference is having the comment at the start of the line so it really stands out and I find it easier to read during code review... But that's not the project spotless configuration 😢
There was a problem hiding this comment.
Will the editor put it in the right place with this config?
Yes.
Before when commenting in the IDE, this would put the comment at the first char.
// log.warn("Cloud Workload Security integration not supported");Then, after a spotlessApply it would be indented as you described.
// log.warn("Cloud Workload Security integration not supported");
With the .editorconfig (that IntelliJ understands), the IDE will create this comment
// log.warn("Cloud Workload Security integration not supported");spotlessApply won't touch the above line since it is properly indented.
| indent_style=space | ||
| indent_size=2 |
There was a problem hiding this comment.
note: Those directives are removed because they duplicate the one in [*]. Empty sections are removed as well.
| indent_style=space | ||
| indent_size=2 | ||
| continuation_indent_size=4 | ||
| ij_java_class_count_to_use_import_on_demand = 99 |
There was a problem hiding this comment.
note: Using 99 everywhere as some directives in other languages don't go over 100
bric3
changed the title
.editorconfig
| ij_java_block_comment_add_space = false | ||
| ij_java_block_comment_at_first_column = false | ||
| ij_java_line_comment_add_space = true | ||
| ij_java_line_comment_add_space_on_reformat = false | ||
| ij_java_line_comment_at_first_column = false |
There was a problem hiding this comment.
❔ question: spotless enforces us to move the // near to the code while the editor puts it at the start of line by default.
Will the editor put it in the right place with this config?
3 participants
What Does This Do
The contributing guide describes a few rules to set on each new checkout or after a
git clean -fdx. Writing those rules in the.editorconfigshould make the IDE aware of them by default without having to configure anything.Those are IJ specific (leveraging IJ
.editorconfigintegration), as I don't think other IDE / text editors support these.Motivation
Ease of setup. No need to setup formater this on other worktrees.
Additional Notes
Contributor Checklist
type:and (comp:orinst:) labels in addition to any usefull labelsclose,fixor any linking keywords when referencing an issue.Use
solvesinstead, and assign the PR milestone to the issueJira ticket: [PROJ-IDENT]